Improve wording and "fix example" (remove 3.13) on testing against pre-release #979
Conversation
…e-releases 3.13 was added in a mass tune up in 0b93645 , without adjusting the wording. With 3.13 listed there too, example does not really make much sense. So I decided to make it explicit in wording and remove 3.13, so whenever next refactoring to add 3.14 to be added to every line where 3.13 is -- this would not even come to attention
|
Hi @yarikoptic, thanks for improving the documentation! |
|
Since here I am not adding a new documentation but rather providing minor tune up to already existing wording, which was potentially added when |
|
Hi @yarikoptic, To keep the original wording intact, it is suggested to only update the version number from 3.12 to 3.14 in the paragraph, like this:
And in the matrix, update the version list to: This way, the example provides a concrete and current reference for configuring workflows with a real pre-release version, making it more practical and helpful for users. |
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for the allow-prereleases feature by updating the example to use Python 3.14 instead of 3.13, making the pre-release scenario more realistic since 3.13 is now generally available.
- Updates example version from 3.13 to 3.14 to better illustrate pre-release behavior
- Adjusts wording to clarify this is a historical example of how the feature would work
- Simplifies the matrix to focus on the single pre-release version being demonstrated
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| matrix: | ||
| os: [Ubuntu, Windows, macOS] | ||
| python_version: ["3.11", "3.12", "3.13"] | ||
| python_version: ["3.14"] |
There was a problem hiding this comment.
@gowridurgad like this?
if you see how to improve further, please use suggestions
so we converge faster.
Description:
3.13 was added in a mass tune up in 0b93645 , without adjusting the wording. With 3.13 listed there too, example does not really make much sense. So I decided to make it explicit in wording and remove 3.13, so whenever next refactoring to add 3.14 to be added to every line where 3.13 is -- this would not even come to attention
Check list: